Skip to content

docs(examples): fix usage filename in chunked submit example#2285

Merged
AntonioCeppellini merged 2 commits into
hiero-ledger:mainfrom
ZainabTravadi:fix/chunked-example-usage-path
May 15, 2026
Merged

docs(examples): fix usage filename in chunked submit example#2285
AntonioCeppellini merged 2 commits into
hiero-ledger:mainfrom
ZainabTravadi:fix/chunked-example-usage-path

Conversation

@ZainabTravadi

@ZainabTravadi ZainabTravadi commented May 14, 2026

Copy link
Copy Markdown
Contributor

Fix incorrect usage/example commands in:

examples/consensus/topic_message_submit_chunked_transaction.py

The example previously referenced a non-existent filename:

topic_message_submit_chunked.py

This has been corrected to reference the actual example file:

topic_message_submit_chunked_transaction.py

Related issue(s):

Fixes #2284

Notes for reviewer:

Validation performed:

  • verified the updated paths match the real example filename
  • confirmed only the intended file changed
  • performed a targeted syntax sanity check using:
    python3 -m py_compile examples/consensus/topic_message_submit_chunked_transaction.py

@ZainabTravadi
docs(examples): fix usage filename in chunked submit example
59ef15b 
Signed-off-by: Zainab Travadi <zainabtravadi421@gmail.com>
Copilot AI review requested due to automatic review settings May 14, 2026 14:56
@ZainabTravadi
ZainabTravadi requested review from a team as code owners May 14, 2026 14:56
@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: af478df0-b534-4a11-98b0-319a172975bb

📥 Commits

Reviewing files that changed from the base of the PR and between 1d47dc2 and 59ef15b.

📒 Files selected for processing (1)
  • examples/consensus/topic_message_submit_chunked_transaction.py

Walkthrough

The example script header documentation was corrected to reference the actual filename topic_message_submit_chunked_transaction.py instead of the previously incorrect topic_message_submit_chunked.py in the usage commands, making the documented examples copy-paste runnable.

Changes

Example command correction

Layer / File(s) Summary
Example command header correction
examples/consensus/topic_message_submit_chunked_transaction.py		 The top-of-file example commands were updated to reference the correct filename for both uv run and direct python invocations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately describes the main change: fixing an incorrect usage filename in the chunked submit example documentation.
Description check ✅ Passed The description is directly related to the changeset, explaining the incorrect filename reference that was corrected and validation performed.
Linked Issues check ✅ Passed The PR successfully addresses issue #2284 by correcting the usage example commands to reference the actual filename, making commands copy-paste runnable.
Out of Scope Changes check ✅ Passed All changes are scoped to the linked issue objective: only the example filename reference in the intended file was corrected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI reviewed May 14, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes incorrect filename references in the docstring usage examples of the chunked topic message submit example, correcting topic_message_submit_chunked.py to the actual filename topic_message_submit_chunked_transaction.py.

Changes:

  • Updated two usage command lines in the module docstring to reference the correct filename.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions Bot added open to community review PR is open for community review and feedback queue:junior-committer PR awaiting initial quality review labels May 14, 2026
@github-actions github-actions Bot added the Good First Issue Issues which are ideal for a first time or new project contributor. label May 14, 2026
@manishdait manishdait added this to the v0.2.7 milestone May 14, 2026
aceppaluni
aceppaluni approved these changes May 14, 2026
View reviewed changes

@aceppaluni aceppaluni left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZainabTravadi Great work, thank you!

Please update your branch and then we can merge.

@manishdait manishdait mentioned this pull request May 14, 2026
Closed
@github-actions github-actions Bot added status: ready-to-merge PR has 1+ maintainer and 2+ total approvals, ready to merge and removed queue:junior-committer PR awaiting initial quality review labels May 15, 2026
@AntonioCeppellini
AntonioCeppellini merged commit 52c15a4 into hiero-ledger:main May 15, 2026
12 checks passed
@github-actions

github-actions Bot commented May 15, 2026

Copy link
Copy Markdown

👋 Hi @ZainabTravadi! Great work completing a Good First Issue issue! 🎉

Thanks for your contribution! 🚀

Here are some issues you might want to explore next:

🌟 Stay connected:

Happy coding! 🚀
— Hiero Python SDK Team

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments
@manishdait manishdait manishdait approved these changes
@aceppaluni aceppaluni aceppaluni approved these changes
@exploreriii exploreriii exploreriii approved these changes
@AntonioCeppellini AntonioCeppellini Awaiting requested review from AntonioCeppellini AntonioCeppellini is a code owner automatically assigned from hiero-ledger/hiero-sdk-python-committers
@nadineloepfe nadineloepfe Awaiting requested review from nadineloepfe nadineloepfe is a code owner automatically assigned from hiero-ledger/hiero-sdk-python-maintainers

Assignees

No one assigned

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. open to community review PR is open for community review and feedback status: ready-to-merge PR has 1+ maintainer and 2+ total approvals, ready to merge

Projects

None yet

Milestone

v0.2.7

Development

Successfully merging this pull request may close these issues.

Incorrect usage filename in chunked consensus example

6 participants

@ZainabTravadi @manishdait @aceppaluni @exploreriii @AntonioCeppellini